-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Metrics Product Docs #15375
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Metrics Product Docs #15375
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
| /> | ||
| - <LinkWithPlatformIcon | ||
| platform="python.aws-lambda" | ||
| label="AWS Lambda" | ||
| url="/platforms/python/guides/aws-lambda/metrics/" | ||
| /> | ||
| - <LinkWithPlatformIcon | ||
| platform="python.gcp-functions" | ||
| label="Google Cloud Functions" | ||
| url="/platforms/python/guides/gcp-functions/metrics/" | ||
| /> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Bug: New documentation links are silently redirected to old span-metrics content due to existing redirects.js rules.
Severity: HIGH | Confidence: 0.90
🔍 Detailed Analysis
New documentation links added in docs/product/explore/metrics/getting-started/index.mdx (lines 19-218), such as /platforms/javascript/metrics/ and /platforms/python/guides/django/metrics/, will be intercepted by existing redirect rules in redirects.js. These rules, like { source: '/platforms/javascript/metrics/:path*', destination: '/platforms/javascript/tracing/span-metrics/:path*', }, will silently redirect users to older span-metrics documentation instead of the intended new Metrics product documentation. This occurs when users click on these newly introduced links.
💡 Suggested Fix
Remove or update the conflicting platform-specific metrics redirects in redirects.js, or confirm that the new documentation paths do not collide with existing redirect patterns.
🤖 Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.
Location: docs/product/explore/metrics/getting-started/index.mdx#L19-L218
Potential issue: New documentation links added in
`docs/product/explore/metrics/getting-started/index.mdx` (lines 19-218), such as
`/platforms/javascript/metrics/` and `/platforms/python/guides/django/metrics/`, will be
intercepted by existing redirect rules in `redirects.js`. These rules, like `{ source:
'/platforms/javascript/metrics/:path*', destination:
'/platforms/javascript/tracing/span-metrics/:path*', }`, will silently redirect users to
older span-metrics documentation instead of the intended new Metrics product
documentation. This occurs when users click on these newly introduced links.
Did we get this right? 👍 / 👎 to inform future reviews.
| ## Trace-Connected Debugging Flow | ||
|
|
||
| Sentry's metrics enable a seamless debugging workflow: | ||
|
|
||
| 1. **Spot the anomaly**: Notice a spike in your Aggregates view (e.g., `checkout.failed` increased 3x) | ||
| 2. **Open samples**: Switch to the Samples tab to see individual metric events | ||
| 3. **Pick a trace**: Click on a sample to open the full trace that produced it | ||
| 4. **Find the cause**: Examine spans for slow queries, check logs for error messages, view related exceptions | ||
| 5. **Fix the issue**: With full context in hand, identify and resolve the root cause | ||
|
|
||
| Instead of "metric alert → guesswork," debugging becomes a **single flow**: Metric spike → sample → trace → root cause. | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| ## Trace-Connected Debugging Flow | |
| Sentry's metrics enable a seamless debugging workflow: | |
| 1. **Spot the anomaly**: Notice a spike in your Aggregates view (e.g., `checkout.failed` increased 3x) | |
| 2. **Open samples**: Switch to the Samples tab to see individual metric events | |
| 3. **Pick a trace**: Click on a sample to open the full trace that produced it | |
| 4. **Find the cause**: Examine spans for slow queries, check logs for error messages, view related exceptions | |
| 5. **Fix the issue**: With full context in hand, identify and resolve the root cause | |
| Instead of "metric alert → guesswork," debugging becomes a **single flow**: Metric spike → sample → trace → root cause. |
I think maybe this section is not needed. It feels like It needs to be an expanded guide. I could see this being replaced with an arcade though.
Co-authored-by: Kyle a.k.a. TechSquidTV <[email protected]>
Co-authored-by: Kyle a.k.a. TechSquidTV <[email protected]>
Bundle ReportChanges will increase total bundle size by 2.11kB (0.01%) ⬆️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-server-cjsAssets Changed:
view changes for bundle: sentry-docs-client-array-pushAssets Changed:
|
DESCRIBE YOUR PR
Tell us what you're changing and why. If your PR resolves an issue, please link it so it closes automatically.
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
LEGAL BOILERPLATE
Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.
EXTRA RESOURCES